edp-service API

edp-service supports 5 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/edp/edplist POST version		Input:	Output:
	Description: List EDP messages selected from database in accordance to selection criterias defined in input parameters. Search parameters can be mixed together to build complex queries. A logical AND is performed between parameters. Example 1: Get ALL EDP messages /epe/edp/edplist Example 2: Get EDP messages for tag with id 3003121667 /epe/edp/edplist?tagid=3003121667 Example 3: Get EDP messages for tag with mac 00:00:B3:00:00:05 /epe/edp/edplist?mac=00:00:B3:00:00:05 Example 4: Get EDP messages for asset with id 14321 /epe/edp/edplist?assetid=14321 Example 5: Get EDP messages for tags with 'test' in asset name /epe/edp/edplist?assetname=test Example 6: List only first 10 EDP messages of the list /epe/edp/edplist?pagesize=10 Example 7: Get the list of EDP messages ordered by tag name in ascending order /epe/edp/edplist?orderby=assetname&ascending=false Role Required: viewer Call Counter: Total: 0, Failed: 0	mac (optional) - [Array] macs of the tags tagid (optional) - [Array] ids of the tags name (optional) - [Array] name of the tags; not exact serial (optional) - [Array] serialnumbers of the tags assetid (optional) - [Array] ids of assets that tags are bound to assetname (optional) - [Array] of assets that tags are bound to orderby (optional) - [String] define sort field, one of: (mac, assetid, assetname, tmestamp etc) ascending (optional) - [String] true=ascending (default), false=descending since (optional) - [String] list edp messages since the specified time. there are two alternative formats; the point of time can be given as milliseconds elapsed since midnight UTC of January 1, 1970. another option is to use the ISO 8601 notation (yyyy-MM-dd hh:mm:ssZ). time zone is optional; if it's omitted, the input is interpreted as server's local time until (optional) - [String] list edp messages until the specified time. format is the same as with since from (optional) - [int] first matching entry that is returned, for pagination (first is 0) pagesize (optional) - [int] how many entries will be returned starting from 'from', for pagination (default is all) format (optional) - [String] format of output, compact or xml; default is xml	EDP.mac - [String] MAC address EDP.assetid - [String] associated asset identifier EDP.assetname - [String] associated asset name EDP.tmestamp - [String] time of receiving the message in server local time EDP.receivedtime - [String] time of receiving the message in human readable format EDP.protocolversion - [String] version of the EDP version EDP.messagetype - [String] type of EDP message: 1 -Vendor Data; 2 - ACK EDP.sequence - [String] sequential number of the message EDP.additionalinfo - [String] bitmasked integer containing additional information: bit0 - ACK requested; all other bits are reserved and must be set to zero EDP.datalength - [String] length of data packet in bytes excluding the header EDP.datablocktype - [String] data block type identifier EDP.datablocklength - [String] data block length in bytes EDP.datablockdata - [String] data block binary data EDP.datablockparsed - [String] parsed data block if availiable
/epe/edp/edpstream POST version		Input:	Output:
	Description: Receive new EDP messages in real time. The connection stays active forever. Whenever a new messages are received, RTLS Controller sends the messages to the caller. Server queues up messages and may drop any new message if the client does not read the stream fast enough. mac, tagid, taggroupid, name are ORed together. Technically this call uses HTTP 1.1 chunked transfer, which provides a way to send multiple chunks of data without closing the connection. See the HTTP specification for the format of the chunks. (The Java SDK automatically takes care of chunking.) A QUERYALIVE message is sent in 10 second interval to check connection aliveness. Ignore this message. Example 1: Receive EDP messages for any tags /epe/edp/edpstream Example 2: Receive EDP messages for tag any 3003121667 /epe/edp/edpstream?tagid=3003121667 Example 3: Receive EDP messages for tag with mac 00:00:B3:00:00:05 /epe/edp/edpstream?mac=00:00:B3:00:00:05 Example 4: Receive EDP messages for tags in group 1 /epe/edp/edpstream?taggroupid=1 Example 5: Receive EDP messages for tags with 'test' in name /epe/edp/edpstream?name=test Role Required: viewer Call Counter: Total: 0, Failed: 0	mac (optional) - [Array] macs of the tags tagid (optional) - [Array] ids of the tags taggroupid (optional) - [Array] ids of the tag groups assetid (optional) - [Array] ids of the assets name (optional) - [Array] name of the tags; not exact format (optional) - [String] format of output, compact or xml; default is xml	EDP.tagid - [long] tag id EDP.mac - [String] MAC address EDP.name - [String] device name EDP.type - [String] device type (such as t201 or t301) EDP.tmestamp - [String] time of receiving the message in server local time EDP.protocolversion - [String] version of the EDP version EDP.messagetype - [String] type of EDP message: 1 -Vendor Data; 2 - ACK EDP.messagetype - [String] type of EDP message: 1 -Vendor Data; 2 - ACK EDP.sequence - [String] sequential number of the message EDP.additionalinfo - [String] bitmasked integer containing additional information: bit0 - ACK requested; all other bits are reserved and must be set to zero EDP.datalength - [String] length of data packet in bytes excluding the header EDP.datablocktype - [String] data block type identifier EDP.datablocklength - [String] data block length in bytes EDP.datablockdata - [String] data block binary data EDP.datablockparsed - [String] parsed data block if availiable
/epe/edp/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/edp/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/edp/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 0, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/edp/_list?help=1)